-
Notifications
You must be signed in to change notification settings - Fork 57
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: add platform ssh docs #469
Conversation
✅ Deploy Preview for docs-hiro ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
953ff16
to
7b30e4f
Compare
7b30e4f
to
00d6b77
Compare
00d6b77
to
16dbee8
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is looking great! I left a few suggestions. We could also add the screenshots when they are ready.
16dbee8
to
d9e9253
Compare
@ryanwaits would you be able to review this one, please? |
|
||
## Save your SSH Key | ||
|
||
Next, you'll provide your public key to the Hiro Platform. You can do this by copying your public key and pasting it into the SSH Public Key field in the Hiro Platform. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
might be nice to add a code snippet for how to copy pk, ex:
for mac: cat ~/.ssh/id_rsa.pub | pbcopy
also, where in the platform would someone find where to paste in the public key? i did a quick check and wasn't sure where to add it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I added for Linux, Mac and Windows and a short phrase and a direct link to the settings (where the user can add the ssh keys)
ForwardAgent yes | ||
``` | ||
|
||
Replace `<your-workspace-url>` with the actual URL of your pod, which should look something like this: https://4a1b57d0c473.platform.hiro.so/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
maybe add some context on how to find the unique pod url, ie you must open a specific project in the editor to find it (unless theres somewhere else in the app where you can find)
949d4df
to
9e53659
Compare
Thanks @ryanwaits for the comments, I addressed those. Let me know if you find anything else, I will be happy to update it. |
@andresgalante @ryanwaits Shall I merge this ? |
9e53659
to
d017ef0
Compare
@sabbyanandan I made the changes you requested, but I can't merge it until you approve. Let me know if there are still things missing. |
Co-authored-by: Sabby Anandan <sabby@hiro.so>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's go!
This is a draft version of the documentation for the platform ssh or how to setup a local editor for the Hiro Platform.
Not to be merged yet as the feature is not yet released on the platform.